home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.1 / bash_builtins.1 < prev    next >
Text File  |  1995-07-25  |  73KB  |  1,189 lines

  1.  
  2.  
  3.  
  4.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           bash, :, ., alias, bg, bind, break, builtin, bye, case, cd,
  10.           command, continue, declare, dirs, echo, enable, eval, exec,
  11.           exit, export, fc, fg, for, getopts, hash, help, history, if,
  12.           jobs, kill, let, local, logout, popd, pushd, pwd, read,
  13.           readonly, return, set, shift, source, suspend, test, times,
  14.           trap, type, typeset, ulimit, umask, unalias, unset, until,
  15.           wait, while - bash built-in commands, see bbbbaaaasssshhhh(1)
  16.  
  17.      BBBBAAAASSSSHHHH BBBBUUUUIIIILLLLTTTTIIIINNNN CCCCOOOOMMMMMMMMAAAANNNNDDDDSSSS
  18.           :::: [_a_r_g_u_m_e_n_t_s]
  19.                No effect; the command does nothing beyond expanding
  20.                _a_r_g_u_m_e_n_t_s and performing any specified redirections.  A
  21.                zero exit code is returned.
  22.  
  23.            ....  _f_i_l_e_n_a_m_e [_a_r_g_u_m_e_n_t_s]
  24.           ssssoooouuuurrrrcccceeee _f_i_l_e_n_a_m_e [_a_r_g_u_m_e_n_t_s]
  25.                Read and execute commands from _f_i_l_e_n_a_m_e in the current
  26.                shell environment and return the exit status of the
  27.                last command executed from _f_i_l_e_n_a_m_e.  If _f_i_l_e_n_a_m_e does
  28.                not contain a slash, pathnames in PPPPAAAATTTTHHHH are used to find
  29.                the directory containing _f_i_l_e_n_a_m_e.  The file searched
  30.                for in PPPPAAAATTTTHHHH need not be executable.  The current
  31.                directory is searched if no file is found in PPPPAAAATTTTHHHH.  If
  32.                any _a_r_g_u_m_e_n_t_s are supplied, they become the positional
  33.                parameters when _f_i_l_e is executed.  Otherwise the
  34.                positional parameters are unchanged.  The return status
  35.                is the status of the last command exited within the
  36.                script (0 if no commands are executed), and false if
  37.                _f_i_l_e_n_a_m_e is not found.
  38.  
  39.           aaaalllliiiiaaaassss [_n_a_m_e[=_v_a_l_u_e] ...]
  40.                AAAAlllliiiiaaaassss with no arguments prints the list of aliases in
  41.                the form _n_a_m_e=_v_a_l_u_e on standard output.  When arguments
  42.                are supplied, an alias is defined for each _n_a_m_e whose
  43.                _v_a_l_u_e is given.  A trailing space in _v_a_l_u_e causes the
  44.                next word to be checked for alias substitution when the
  45.                alias is expanded.  For each _n_a_m_e in the argument list
  46.                for which no _v_a_l_u_e is supplied, the name and value of
  47.                the alias is printed.  AAAAlllliiiiaaaassss returns true unless a _n_a_m_e
  48.                is given for which no alias has been defined.
  49.  
  50.           bbbbgggg [_j_o_b_s_p_e_c]
  51.                Place _j_o_b_s_p_e_c in the background, as if it had been
  52.                started with &&&&.  If _j_o_b_s_p_e_c is not present, the shell's
  53.                notion of the _c_u_r_r_e_n_t _j_o_b is used.  bbbbgggg _j_o_b_s_p_e_c returns
  54.                0 unless run when job control is disabled or, when run
  55.                with job control enabled, if _j_o_b_s_p_e_c was not found or
  56.                started without job control.
  57.  
  58.           bbbbiiiinnnndddd [----mmmm _k_e_y_m_a_p] [----llllvvvvdddd] [----qqqq _n_a_m_e]
  59.           bbbbiiiinnnndddd [----mmmm _k_e_y_m_a_p] ----ffff _f_i_l_e_n_a_m_e
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 7/7/95)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  71.  
  72.  
  73.  
  74.           bbbbiiiinnnndddd [----mmmm _k_e_y_m_a_p] _k_e_y_s_e_q:_f_u_n_c_t_i_o_n-_n_a_m_e
  75.                Display current rrrreeeeaaaaddddlllliiiinnnneeee key and function bindings, or
  76.                bind a key sequence to a rrrreeeeaaaaddddlllliiiinnnneeee function or macro.
  77.                The binding syntax accepted is identical to that of
  78.                ._i_n_p_u_t_r_c, but each binding must be passed as a separate
  79.                argument; e.g., '"\C-x\C-r": re-read-init-file'.
  80.                Options, if supplied, have the following meanings:
  81.                ----mmmm _k_e_y_m_a_p
  82.                     Use _k_e_y_m_a_p as the keymap to be affected by the
  83.                     subsequent bindings.  Acceptable _k_e_y_m_a_p names are
  84.                     _e_m_a_c_s, _e_m_a_c_s-_s_t_a_n_d_a_r_d, _e_m_a_c_s-_m_e_t_a, _e_m_a_c_s-_c_t_l_x, _v_i,
  85.                     _v_i-_m_o_v_e, _v_i-_c_o_m_m_a_n_d, and _v_i-_i_n_s_e_r_t.  _v_i is
  86.                     equivalent to _v_i-_c_o_m_m_a_n_d; _e_m_a_c_s is equivalent to
  87.                     _e_m_a_c_s-_s_t_a_n_d_a_r_d.
  88.                ----llll   List the names of all rrrreeeeaaaaddddlllliiiinnnneeee functions
  89.                ----vvvv   List current function names and bindings
  90.                ----dddd   Dump function names and bindings in such a way
  91.                     that they can be re-read
  92.                ----ffff _f_i_l_e_n_a_m_e
  93.                     Read key bindings from _f_i_l_e_n_a_m_e
  94.                ----qqqq _f_u_n_c_t_i_o_n
  95.                     Query about which keys invoke the named _f_u_n_c_t_i_o_n
  96.  
  97.                The return value is 0 unless an unrecognized option is
  98.                given or an error occurred.
  99.  
  100.           bbbbrrrreeeeaaaakkkk [_n]
  101.                Exit from within a ffffoooorrrr, wwwwhhhhiiiilllleeee, or uuuunnnnttttiiiillll loop.  If _n is
  102.                specified, break _n levels.  _n must be >_ 1.  If _n is
  103.                greater than the number of enclosing loops, all
  104.                enclosing loops are exited.  The return value is 0
  105.                unless the shell is not executing a loop when bbbbrrrreeeeaaaakkkk is
  106.                executed.
  107.  
  108.           bbbbuuuuiiiillllttttiiiinnnn _s_h_e_l_l-_b_u_i_l_t_i_n [_a_r_g_u_m_e_n_t_s]
  109.                Execute the specified shell builtin, passing it
  110.                _a_r_g_u_m_e_n_t_s, and return its exit status.  This is useful
  111.                when you wish to define a function whose name is the
  112.                same as a shell builtin, but need the functionality of
  113.                the builtin within the function itself.  The ccccdddd builtin
  114.                is commonly redefined this way.  The return status is
  115.                false if _s_h_e_l_l-_b_u_i_l_t_i_n is not a shell builtin command.
  116.  
  117.           ccccdddd [_d_i_r]
  118.                Change the current directory to _d_i_r.  The variable HHHHOOOOMMMMEEEE
  119.                is the default _d_i_r.  The variable CCCCDDDDPPPPAAAATTTTHHHH defines the
  120.                search path for the directory containing _d_i_r.
  121.                Alternative directory names are separated by a colon
  122.                (:).  A null directory name in CCCCDDDDPPPPAAAATTTTHHHH is the same as
  123.                the current directory, i.e., ``....''.  If _d_i_r begins with
  124.                a slash (/), then CCCCDDDDPPPPAAAATTTTHHHH is not used.  An argument of ----
  125.                is equivalent to $$$$OOOOLLLLDDDDPPPPWWWWDDDD.  The return value is true if
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 7/7/95)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  137.  
  138.  
  139.  
  140.                the directory was successfully changed; false
  141.                otherwise.
  142.  
  143.           ccccoooommmmmmmmaaaannnndddd [----ppppVVVVvvvv] _c_o_m_m_a_n_d [_a_r_g ...]
  144.                Run _c_o_m_m_a_n_d with _a_r_g_s suppressing the normal shell
  145.                function lookup. Only builtin commands or commands
  146.                found in the PPPPAAAATTTTHHHH are executed.  If the ----pppp option is
  147.                given, the search for _c_o_m_m_a_n_d is performed using a
  148.                default value for PPPPAAAATTTTHHHH that is guaranteed to find all
  149.                of the standard utilities.  If either the ----VVVV or ----vvvv
  150.                option is supplied, a description of _c_o_m_m_a_n_d is
  151.                printed.  The ----vvvv option causes a single word indicating
  152.                the command or pathname used to invoke _c_o_m_m_a_n_d to be
  153.                printed; the ----VVVV option produces a more verbose
  154.                description.  An argument of -------- disables option
  155.                checking for the rest of the arguments.  If the ----VVVV or
  156.                ----vvvv option is supplied, the exit status is 0 if _c_o_m_m_a_n_d
  157.                was found, and 1 if not.  If neither option is supplied
  158.                and an error occurred or _c_o_m_m_a_n_d cannot be found, the
  159.                exit status is 127.  Otherwise, the exit status of the
  160.                ccccoooommmmmmmmaaaannnndddd builtin is the exit status of _c_o_m_m_a_n_d.
  161.  
  162.           ccccoooonnnnttttiiiinnnnuuuueeee [_n]
  163.                Resume the next iteration of the enclosing ffffoooorrrr, wwwwhhhhiiiilllleeee,
  164.                or uuuunnnnttttiiiillll loop.  If _n is specified, resume at the _nth
  165.                enclosing loop.  _n must be >_ 1.  If _n is greater than
  166.                the number of enclosing loops, the last enclosing loop
  167.                (the `top-level' loop) is resumed.  The return value is
  168.                0 unless the shell is not executing a loop when
  169.                ccccoooonnnnttttiiiinnnnuuuueeee is executed.
  170.  
  171.           ddddeeeeccccllllaaaarrrreeee [----ffffrrrrxxxxiiii] [_n_a_m_e[=_v_a_l_u_e]]
  172.           ttttyyyyppppeeeesssseeeetttt [----ffffrrrrxxxxiiii] [_n_a_m_e[=_v_a_l_u_e]]
  173.                Declare variables and/or give them attributes.  If no
  174.                _n_a_m_es are given, then display the values of variables
  175.                instead.  The options can be used to restrict output to
  176.                variables with the specified attribute.
  177.                ----ffff   Use function names only
  178.                ----rrrr   Make _n_a_m_es readonly.  These names cannot then be
  179.                     assigned values by subsequent assignment
  180.                     statements.
  181.                ----xxxx   Mark _n_a_m_es for export to subsequent commands via
  182.                     the environment.
  183.                ----iiii   The variable is treated as an integer; arithmetic
  184.                     evaluation (see AAAARRRRIIIITTTTHHHHMMMMEEEETTTTIIIICCCC EEEEVVVVAAAALLLLUUUUAAAATTTTIIIIOOOONNNN )))) is
  185.                     performed when the variable is assigned a value.
  186.  
  187.                Using `+' instead of `-' turns off the attribute
  188.                instead.  When used in a function, makes _n_a_m_es local,
  189.                as with the llllooooccccaaaallll command.  The return value is 0
  190.                unless an illegal option is encountered, an attempt is
  191.                made to define a function using "-f foo=bar", one of
  192.  
  193.  
  194.  
  195.      Page 3                                           (printed 7/7/95)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  203.  
  204.  
  205.  
  206.                the _n_a_m_e_s is not a legal shell variable name, an
  207.                attempt is made to turn off readonly status for a
  208.                readonly variable, or an attempt is made to display a
  209.                non-existant function with -f.
  210.  
  211.           ddddiiiirrrrssss [[[[----llll]]]] [[[[++++////----nnnn]]]]
  212.                Display the list of currently remembered directories.
  213.                Directories are added to the list with the ppppuuuusssshhhhdddd
  214.                command; the ppppooooppppdddd command moves back up through the
  215.                list.
  216.                ++++nnnn   displays the _nth entry counting from the left of
  217.                     the list shown by ddddiiiirrrrssss when invoked without
  218.                     options, starting with zero.
  219.                ----nnnn   displays the _nth entry counting from the right of
  220.                     the list shown by ddddiiiirrrrssss when invoked without
  221.                     options, starting with zero.
  222.                ----llll   produces a longer listing; the default listing
  223.                     format uses a tilde to denote the home directory.
  224.  
  225.                The return value is 0 unless an illegal option is
  226.                supplied or _n indexes beyond the end of the directory
  227.                stack.
  228.  
  229.           eeeecccchhhhoooo [----nnnneeeeEEEE] [_a_r_g ...]
  230.                Output the _a_r_gs, separated by spaces.  The return
  231.                status is always 0.  If ----nnnn is specified, the trailing
  232.                newline is suppressed.  If the ----eeee option is given,
  233.                interpretation of the following backslash-escaped
  234.                characters is enabled.  The ----EEEE option disables the
  235.                interpretation of these escape characters, even on
  236.                systems where they are interpreted by default.
  237.                \\\\aaaa   alert (bell)
  238.                \\\\bbbb   backspace
  239.                \\\\cccc   suppress trailing newline
  240.                \\\\ffff   form feed
  241.                \\\\nnnn   new line
  242.                \\\\rrrr   carriage return
  243.                \\\\tttt   horizontal tab
  244.                \\\\vvvv   vertical tab
  245.                \\\\\\\\   backslash
  246.                \\\\nnnnnnnnnnnn the character whose ASCII code is _n_n_n (octal)
  247.  
  248.           eeeennnnaaaabbbblllleeee [----nnnn] [----aaaallllllll] [_n_a_m_e ...]
  249.                Enable and disable builtin shell commands.  This allows
  250.                the execution of a disk command which has the same name
  251.                as a shell builtin without specifying a full pathname.
  252.                If ----nnnn is used, each _n_a_m_e is disabled; otherwise, _n_a_m_e_s
  253.                are enabled.  For example, to use the tttteeeesssstttt binary found
  254.                via the PPPPAAAATTTTHHHH instead of the shell builtin version, type
  255.                ``enable -n test''.  If no arguments are given, a list
  256.                of all enabled shell builtins is printed.  If only ----nnnn
  257.                is supplied, a list of all disabled builtins is
  258.  
  259.  
  260.  
  261.      Page 4                                           (printed 7/7/95)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  269.  
  270.  
  271.  
  272.                printed.  If only ----aaaallllllll is supplied, the list printed
  273.                includes all builtins, with an indication of whether or
  274.                not each is enabled.  eeeennnnaaaabbbblllleeee accepts ----aaaa as a synonym
  275.                for ----aaaallllllll.  The return value is 0 unless a _n_a_m_e is not a
  276.                shell builtin.
  277.  
  278.           eeeevvvvaaaallll [_a_r_g ...]
  279.                The _a_r_gs are read and concatenated together into a
  280.                single command.  This command is then read and executed
  281.                by the shell, and its exit status is returned as the
  282.                value of the eeeevvvvaaaallll command.  If there are no _a_r_g_s, or
  283.                only null arguments, eeeevvvvaaaallll returns true.
  284.  
  285.           eeeexxxxeeeecccc [[----] _c_o_m_m_a_n_d [_a_r_g_u_m_e_n_t_s]]
  286.                If _c_o_m_m_a_n_d is specified, it replaces the shell.  No new
  287.                process is created.  The _a_r_g_u_m_e_n_t_s become the arguments
  288.                to _c_o_m_m_a_n_d.  If the first argument is ----, the shell
  289.                places a dash in the zeroth arg passed to _c_o_m_m_a_n_d.
  290.                This is what login does.  If the file cannot be
  291.                executed for some reason, a non-interactive shell
  292.                exits, unless the shell variable nnnnoooo____eeeexxxxiiiitttt____oooonnnn____ffffaaaaiiiilllleeeedddd____eeeexxxxeeeecccc
  293.                exists, in which case it returns failure.  An
  294.                interactive shell returns failure if the file cannot be
  295.                executed.  If _c_o_m_m_a_n_d is not specified, any
  296.                redirections take effect in the current shell, and the
  297.                return status is 0.
  298.  
  299.           eeeexxxxiiiitttt [_n]
  300.                Cause the shell to exit with a status of _n.  If _n is
  301.                omitted, the exit status is that of the last command
  302.                executed.  A trap on EEEEXXXXIIIITTTT is executed before the shell
  303.                terminates.
  304.  
  305.           eeeexxxxppppoooorrrrtttt [----nnnnffff] [_n_a_m_e[=_w_o_r_d]] ...
  306.           eeeexxxxppppoooorrrrtttt ----pppp
  307.                The supplied _n_a_m_e_s are marked for automatic export to
  308.                the environment of subsequently executed commands.  If
  309.                the ----ffff option is given, the _n_a_m_e_s refer to functions.
  310.                If no _n_a_m_e_s are given, or if the ----pppp option is supplied,
  311.                a list of all names that are exported in this shell is
  312.                printed.  The ----nnnn option causes the export property to
  313.                be removed from the named variables.  An argument of --------
  314.                disables option checking for the rest of the arguments.
  315.                eeeexxxxppppoooorrrrtttt returns an exit status of 0 unless an illegal
  316.                option is encountered, one of the _n_a_m_e_s is not a legal
  317.                shell variable name, or ----ffff is supplied with a _n_a_m_e that
  318.                is not a function.
  319.  
  320.           ffffcccc [----eeee _e_n_a_m_e] [----nnnnllllrrrr] [_f_i_r_s_t] [_l_a_s_t]
  321.           ffffcccc ----ssss [_p_a_t=_r_e_p] [_c_m_d]
  322.                Fix Command.  In the first form, a range of commands
  323.                from _f_i_r_s_t to _l_a_s_t is selected from the history list.
  324.  
  325.  
  326.  
  327.      Page 5                                           (printed 7/7/95)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  335.  
  336.  
  337.  
  338.                _F_i_r_s_t and _l_a_s_t may be specified as a string (to locate
  339.                the last command beginning with that string) or as a
  340.                number (an index into the history list, where a
  341.                negative number is used as an offset from the current
  342.                command number).  If _l_a_s_t is not specified it is set to
  343.                the current command for listing (so that ffffcccc ----llll ----11110000
  344.                prints the last 10 commands) and to _f_i_r_s_t otherwise.
  345.                If _f_i_r_s_t is not specified it is set to the previous
  346.                command for editing and -16 for listing.
  347.  
  348.                The ----nnnn flag suppresses the command numbers when
  349.                listing.  The ----rrrr flag reverses the order of the
  350.                commands.  If the ----llll flag is given, the commands are
  351.                listed on standard output.  Otherwise, the editor given
  352.                by _e_n_a_m_e is invoked on a file containing those
  353.                commands.  If _e_n_a_m_e is not given, the value of the
  354.                FFFFCCCCEEEEDDDDIIIITTTT variable is used, and the value of EEEEDDDDIIIITTTTOOOORRRR if
  355.                FFFFCCCCEEEEDDDDIIIITTTT is not set.  If neither variable is set, is
  356.                used.  When editing is complete, the edited commands
  357.                are echoed and executed.
  358.  
  359.                In the second form, _c_o_m_m_a_n_d is re-executed after each
  360.                instance of _p_a_t is replaced by _r_e_p.  A useful alias to
  361.                use with this is ``r=fc -s'', so that typing ``r cc''
  362.                runs the last command beginning with ``cc'' and typing
  363.                ``r'' re-executes the last command.
  364.  
  365.                If the first form is used, the return value is 0 unless
  366.                an illegal option is encountered or _f_i_r_s_t or _l_a_s_t
  367.                specify history lines out of range.  If the ----eeee option
  368.                is supplied, the return value is the value of the last
  369.                command executed or failure if an error occurs with the
  370.                temporary file of commands.  If the second form is
  371.                used, the return status is that of the command re-
  372.                executed, unless _c_m_d does not specify a valid history
  373.                line, in which case ffffcccc returns failure.
  374.  
  375.           ffffgggg [_j_o_b_s_p_e_c]
  376.                Place _j_o_b_s_p_e_c in the foreground, and make it the
  377.                current job.  If _j_o_b_s_p_e_c is not present, the shell's
  378.                notion of the _c_u_r_r_e_n_t _j_o_b is used.  The return value is
  379.                that of the command placed into the foreground, or
  380.                failure if run when job control is disabled or, when
  381.                run with job control enabled, if _j_o_b_s_p_e_c does not
  382.                specify a valid job or _j_o_b_s_p_e_c specifies a job that was
  383.                started without job control.
  384.  
  385.           ggggeeeettttooooppppttttssss _o_p_t_s_t_r_i_n_g _n_a_m_e [_a_r_g_s]
  386.                ggggeeeettttooooppppttttssss is used by shell procedures to parse positional
  387.                parameters.  _o_p_t_s_t_r_i_n_g contains the option letters to
  388.                be recognized; if a letter is followed by a colon, the
  389.                option is expected to have an argument, which should be
  390.  
  391.  
  392.  
  393.      Page 6                                           (printed 7/7/95)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  401.  
  402.  
  403.  
  404.                separated from it by white space.  Each time it is
  405.                invoked, ggggeeeettttooooppppttttssss places the next option in the shell
  406.                variable _n_a_m_e, initializing _n_a_m_e if it does not exist,
  407.                and the index of the next argument to be processed into
  408.                the variable OOOOPPPPTTTTIIIINNNNDDDD.  OOOOPPPPTTTTIIIINNNNDDDD is initialized to 1 each
  409.                time the shell or a shell script is invoked.  When an
  410.                option requires an argument, ggggeeeettttooooppppttttssss places that
  411.                argument into the variable OOOOPPPPTTTTAAAARRRRGGGG.  The shell does not
  412.                reset OOOOPPPPTTTTIIIINNNNDDDD automatically; it must be manually reset
  413.                between multiple calls to ggggeeeettttooooppppttttssss within the same shell
  414.                invocation if a new set of parameters is to be used.
  415.  
  416.                ggggeeeettttooooppppttttssss can report errors in two ways.  If the first
  417.                character of _o_p_t_s_t_r_i_n_g is a colon, _s_i_l_e_n_t error
  418.                reporting is used.  In normal operation diagnostic
  419.                messages are printed when illegal options or missing
  420.                option arguments are encountered.  If the variable
  421.                OOOOPPPPTTTTEEEERRRRRRRR is set to 0, no error message will be displayed,
  422.                even if the first character of _o_p_t_s_t_r_i_n_g is not a
  423.                colon.
  424.  
  425.                If an illegal option is seen, ggggeeeettttooooppppttttssss places ? into
  426.                _n_a_m_e and, if not silent, prints an error message and
  427.                unsets OOOOPPPPTTTTAAAARRRRGGGG.  If ggggeeeettttooooppppttttssss is silent, the option
  428.                character found is placed in OOOOPPPPTTTTAAAARRRRGGGG and no diagnostic
  429.                message is printed.
  430.  
  431.                If a required argument is not found, and ggggeeeettttooooppppttttssss is not
  432.                silent, a question mark (????) is placed in _n_a_m_e, OOOOPPPPTTTTAAAARRRRGGGG
  433.                is unset, and a diagnostic message is printed.  If
  434.                ggggeeeettttooooppppttttssss is silent, then a colon (::::) is placed in _n_a_m_e
  435.                and OOOOPPPPTTTTAAAARRRRGGGG is set to the option character found.
  436.  
  437.                ggggeeeettttooooppppttttssss normally parses the positional parameters, but
  438.                if more arguments are given in _a_r_g_s, ggggeeeettttooooppppttttssss parses
  439.                those instead.  ggggeeeettttooooppppttttssss returns true if an option,
  440.                specified or unspecified, is found.  It returns false
  441.                if the end of options is encountered or an error
  442.                occurs.
  443.  
  444.           hhhhaaaasssshhhh [----rrrr] [_n_a_m_e]
  445.                For each _n_a_m_e, the full pathname of the command is
  446.                determined and remembered.  The ----rrrr option causes the
  447.                shell to forget all remembered locations.  If no
  448.                arguments are given, information about remembered
  449.                commands is printed.  An argument of -------- disables option
  450.                checking for the rest of the arguments.  The return
  451.                status is true unless a _n_a_m_e is not found or an illegal
  452.                option is supplied.
  453.  
  454.           hhhheeeellllpppp [_p_a_t_t_e_r_n]
  455.                Display helpful information about builtin commands.  If
  456.  
  457.  
  458.  
  459.      Page 7                                           (printed 7/7/95)
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  467.  
  468.  
  469.  
  470.                _p_a_t_t_e_r_n is specified, hhhheeeellllpppp gives detailed help on all
  471.                commands matching _p_a_t_t_e_r_n; otherwise a list of the
  472.                builtins is printed.  The return status is 0 unless no
  473.                command matches _p_a_t_t_e_r_n.
  474.  
  475.           hhhhiiiissssttttoooorrrryyyy [_n]
  476.           hhhhiiiissssttttoooorrrryyyy ----rrrrwwwwaaaannnn [_f_i_l_e_n_a_m_e]
  477.                With no options, display the command history list with
  478.                line numbers.  Lines listed with a **** have been
  479.                modified.  An argument of _n lists only the last _n
  480.                lines.  If a non-option argument is supplied, it is
  481.                used as the name of the history file; if not, the value
  482.                of HHHHIIIISSSSTTTTFFFFIIIILLLLEEEE is used.  Options, if supplied, have the
  483.                following meanings:
  484.                ----aaaa   Append the ``new'' history lines (history lines
  485.                     entered since the beginning of the current bbbbaaaasssshhhh
  486.                     session) to the history file
  487.                ----nnnn   Read the history lines not already read from the
  488.                     history file into the current history list.  These
  489.                     are lines appended to the history file since the
  490.                     beginning of the current bbbbaaaasssshhhh session.
  491.                ----rrrr   Read the contents of the history file and use them
  492.                     as the current history
  493.                ----wwww   Write the current history to the history file,
  494.                     overwriting the history file's contents.
  495.  
  496.                The return value is 0 unless an illegal option is
  497.                encountered or an error occurs while reading or writing
  498.                the history file.
  499.  
  500.           jjjjoooobbbbssss [----llllnnnnpppp] [ _j_o_b_s_p_e_c ... ]
  501.           jjjjoooobbbbssss ----xxxx _c_o_m_m_a_n_d [ _a_r_g_s ... ]
  502.                The first form lists the active jobs.  The ----llll option
  503.                lists process IDs in addition to the normal
  504.                information; the ----pppp option lists only the process ID of
  505.                the job's process group leader.  The ----nnnn option displays
  506.                only jobs that have changed status since last notified.
  507.                If _j_o_b_s_p_e_c is given, output is restricted to
  508.                information about that job.  The return status is 0
  509.                unless an illegal option is encountered or an illegal
  510.                _j_o_b_s_p_e_c is supplied.
  511.  
  512.                If the ----xxxx option is supplied, jjjjoooobbbbssss replaces any _j_o_b_s_p_e_c
  513.                found in _c_o_m_m_a_n_d or _a_r_g_s with the corresponding process
  514.                group ID, and executes _c_o_m_m_a_n_d passing it _a_r_g_s,
  515.                returning its exit status.
  516.  
  517.           kkkkiiiillllllll [----ssss ssssiiiiggggssssppppeeeecccc | ----ssssiiiiggggssssppppeeeecccc] [_p_i_d | _j_o_b_s_p_e_c] ...
  518.           kkkkiiiillllllll ----llll [_s_i_g_n_u_m]
  519.                Send the signal named by _s_i_g_s_p_e_c to the processes named
  520.                by _p_i_d or _j_o_b_s_p_e_c.  _s_i_g_s_p_e_c is either a signal name
  521.                such as SSSSIIIIGGGGKKKKIIIILLLLLLLL or a signal number.  If _s_i_g_s_p_e_c is a
  522.  
  523.  
  524.  
  525.      Page 8                                           (printed 7/7/95)
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  533.  
  534.  
  535.  
  536.                signal name, the name is case insensitive and may be
  537.                given with or without the SSSSIIIIGGGG prefix.  If _s_i_g_s_p_e_c is
  538.                not present, then SSSSIIIIGGGGTTTTEEEERRRRMMMM is assumed.  An argument of
  539.                ----llll lists the signal names.  If any arguments are
  540.                supplied when ----llll is given, the names of the specified
  541.                signals are listed, and the return status is 0.  An
  542.                argument of -------- disables option checking for the rest of
  543.                the arguments.  kkkkiiiillllllll returns true if at least one
  544.                signal was successfully sent, or false if an error
  545.                occurs or an illegal option is encountered.
  546.  
  547.           lllleeeetttt _a_r_g [_a_r_g ...]
  548.                Each _a_r_g is an arithmetic expression to be evaluated
  549.                (see AAAARRRRIIIITTTTHHHHMMMMEEEETTTTIIIICCCC EEEEVVVVAAAALLLLUUUUAAAATTTTIIIIOOOONNNN).  If the last _a_r_g evaluates
  550.                to 0, lllleeeetttt returns 1; 0 is returned otherwise.
  551.  
  552.           llllooooccccaaaallll [_n_a_m_e[=_v_a_l_u_e] ...]
  553.                For each argument, create a local variable named _n_a_m_e,
  554.                and assign it _v_a_l_u_e.  When llllooooccccaaaallll is used within a
  555.                function, it causes the variable _n_a_m_e to have a visible
  556.                scope restricted to that function and its children.
  557.                With no operands, llllooooccccaaaallll writes a list of local
  558.                variables to the standard output.  It is an error to
  559.                use llllooooccccaaaallll when not within a function.  The return
  560.                status is 0 unless llllooooccccaaaallll is used outside a function, or
  561.                an illegal _n_a_m_e is supplied.
  562.  
  563.           llllooooggggoooouuuutttt
  564.                Exit a login shell.
  565.  
  566.           ppppooooppppdddd [++++////----nnnn]
  567.                Removes entries from the directory stack.  With no
  568.                arguments, removes the top directory from the stack,
  569.                and performs a ccccdddd to the new top directory.
  570.                ++++nnnn   removes the _nth entry counting from the left of
  571.                     the list shown by ddddiiiirrrrssss, starting with zero.  For
  572.                     example: ``popd +0'' removes the first directory,
  573.                     ``popd +1'' the second.
  574.                ----nnnn   removes the _nth entry counting from the right of
  575.                     the list shown by ddddiiiirrrrssss, starting with zero.  For
  576.                     example: ``popd -0'' removes the last directory,
  577.                     ``popd -1'' the next to last.
  578.  
  579.                If the ppppooooppppdddd command is successful, a ddddiiiirrrrssss is performed
  580.                as well, and the return status is 0.  ppppooooppppdddd returns
  581.                false if an illegal option is encountered, the
  582.                directory stack is empty, a non-existent directory
  583.                stack entry is specified, or the directory change
  584.                fails.
  585.  
  586.           ppppuuuusssshhhhdddd [_d_i_r]
  587.           ppppuuuusssshhhhdddd ++++////----nnnn
  588.  
  589.  
  590.  
  591.      Page 9                                           (printed 7/7/95)
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  599.  
  600.  
  601.  
  602.                Adds a directory to the top of the directory stack, or
  603.                rotates the stack, making the new top of the stack the
  604.                current working directory.  With no arguments,
  605.                exchanges the top two directories and returns 0, unless
  606.                the directory stack is empty.
  607.                ++++nnnn   Rotates the stack so that the _nth directory
  608.                     (counting from the left of the list shown by ddddiiiirrrrssss)
  609.                     is at the top.
  610.                ----nnnn   Rotates the stack so that the _nth directory
  611.                     (counting from the right) is at the top.
  612.                ddddiiiirrrr  adds _d_i_r to the directory stack at the top, making
  613.                     it the new current working directory.
  614.  
  615.                If the ppppuuuusssshhhhdddd command is successful, a ddddiiiirrrrssss is performed
  616.                as well.  If the first form is used, ppppuuuusssshhhhdddd returns 0
  617.                unless the cd to _d_i_r fails.  With the second form,
  618.                ppppuuuusssshhhhdddd returns 0 unless the directory stack is empty, a
  619.                non-existant directory stack element is specified, or
  620.                the directory change to the specified new current
  621.                directory fails.
  622.  
  623.           ppppwwwwdddd  Print the absolute pathname of the current working
  624.                directory.  The path printed contains no symbolic links
  625.                if the ----PPPP option to the sssseeeetttt builtin command is set.
  626.                See also the description of nnnnoooolllliiiinnnnkkkkssss under SSSShhhheeeellllllll
  627.                VVVVaaaarrrriiiiaaaabbbblllleeeessss above).  The return status is 0 unless an
  628.                error occurs while reading the pathname of the current
  629.                directory.
  630.  
  631.           rrrreeeeaaaadddd [----rrrr] [_n_a_m_e ...]
  632.                One line is read from the standard input, and the first
  633.                word is assigned to the first _n_a_m_e, the second word to
  634.                the second _n_a_m_e, and so on, with leftover words
  635.                assigned to the last _n_a_m_e.  Only the characters in IIIIFFFFSSSS
  636.                are recognized as word delimiters.  If no _n_a_m_e_s are
  637.                supplied, the line read is assigned to the variable
  638.                RRRREEEEPPPPLLLLYYYY.  The return code is zero, unless end-of-file is
  639.                encountered.  If the ----rrrr option is given, a backslash-
  640.                newline pair is not ignored, and the backslash is
  641.                considered to be part of the line.
  642.  
  643.           rrrreeeeaaaaddddoooonnnnllllyyyy [----ffff] [_n_a_m_e ...]
  644.           rrrreeeeaaaaddddoooonnnnllllyyyy ----pppp
  645.                The given _n_a_m_e_s are marked readonly and the values of
  646.                these _n_a_m_e_s may not be changed by subsequent
  647.                assignment.  If the ----ffff option is supplied, the
  648.                functions corresponding to the _n_a_m_e_s are so marked.  If
  649.                no arguments are given, or if the ----pppp option is
  650.                supplied, a list of all readonly names is printed.  An
  651.                argument of -------- disables option checking for the rest of
  652.                the arguments.  The return status is 0 unless an
  653.                illegal option is encountered, one of the _n_a_m_e_s is not
  654.  
  655.  
  656.  
  657.      Page 10                                          (printed 7/7/95)
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  665.  
  666.  
  667.  
  668.                a legal shell variable name, or ----ffff is supplied with a
  669.                _n_a_m_e that is not a function.
  670.  
  671.           rrrreeeettttuuuurrrrnnnn [_n]
  672.                Causes a function to exit with the return value
  673.                specified by _n.  If _n is omitted, the return status is
  674.                that of the last command executed in the function body.
  675.                If used outside a function, but during execution of a
  676.                script by the .... (ssssoooouuuurrrrcccceeee) command, it causes the shell
  677.                to stop executing that script and return either _n or
  678.                the exit status of the last command executed within the
  679.                script as the exit status of the script.  If used
  680.                outside a function and not during execution of a script
  681.                by ...., the return status is false.
  682.  
  683.           sssseeeetttt [--------aaaabbbbeeeeffffhhhhkkkkmmmmnnnnppppttttuuuuvvvvxxxxllllddddCCCCHHHHPPPP] [----oooo _o_p_t_i_o_n] [_a_r_g ...]
  684.                ----aaaa      Automatically mark variables which are modified
  685.                        or created for export to the environment of
  686.                        subsequent commands.
  687.                ----bbbb      Cause the status of terminated background jobs
  688.                        to be reported immediately, rather than before
  689.                        the next primary prompt.  (Also see nnnnoooottttiiiiffffyyyy
  690.                        under SSSShhhheeeellllllll VVVVaaaarrrriiiiaaaabbbblllleeeessss above).
  691.                ----eeee      Exit immediately if a _s_i_m_p_l_e-_c_o_m_m_a_n_d (see SSSSHHHHEEEELLLLLLLL
  692.                        GGGGRRRRAAAAMMMMMMMMAAAARRRR above) exits with a non-zero status.
  693.                        The shell does not exit if the command that
  694.                        fails is part of an _u_n_t_i_l or _w_h_i_l_e loop, part
  695.                        of an _i_f statement, part of a &&&&&&&& or |||||||| list, or
  696.                        if the command's return value is being inverted
  697.                        via !!!!.
  698.                ----ffff      Disable pathname expansion.
  699.                ----hhhh      Locate and remember function commands as
  700.                        functions are defined.  Function commands are
  701.                        normally looked up when the function is
  702.                        executed.
  703.                ----kkkk      All keyword arguments are placed in the
  704.                        environment for a command, not just those that
  705.                        precede the command name.
  706.                ----mmmm      Monitor mode.  Job control is enabled.  This
  707.                        flag is on by default for interactive shells on
  708.                        systems that support it (see JJJJOOOOBBBB CCCCOOOONNNNTTTTRRRROOOOLLLL
  709.                        above).  Background processes run in a separate
  710.                        process group and a line containing their exit
  711.                        status is printed upon their completion.
  712.                ----nnnn      Read commands but do not execute them.  This
  713.                        may be used to check a shell script for syntax
  714.                        errors.  This is ignored for interactive
  715.                        shells.
  716.                ----oooo _o_p_t_i_o_n-_n_a_m_e
  717.                        The _o_p_t_i_o_n-_n_a_m_e can be one of the following:
  718.                        aaaalllllllleeeexxxxppppoooorrrrtttt
  719.                                Same as ----aaaa.
  720.  
  721.  
  722.  
  723.      Page 11                                          (printed 7/7/95)
  724.  
  725.  
  726.  
  727.  
  728.  
  729.  
  730.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  731.  
  732.  
  733.  
  734.                        bbbbrrrraaaacccceeeeeeeexxxxppppaaaannnndddd
  735.                                The shell performs brace expansion (see
  736.                                BBBBrrrraaaacccceeee EEEExxxxppppaaaannnnssssiiiioooonnnn above).  This is on by
  737.                                default.
  738.                        eeeemmmmaaaaccccssss   Use an emacs-style command line editing
  739.                                interface.  This is enabled by default
  740.                                when the shell is interactive, unless
  741.                                the shell is started with the
  742.                                ----nnnnoooolllliiiinnnneeeeeeeeddddiiiittttiiiinnnngggg option.
  743.                        eeeerrrrrrrreeeexxxxiiiitttt Same as ----eeee.
  744.                        hhhhiiiisssstttteeeexxxxppppaaaannnndddd
  745.                                Same as ----HHHH.
  746.                        iiiiggggnnnnoooorrrreeeeeeeeooooffff
  747.                                The effect is as if the shell command
  748.                                `IGNOREEOF=10' had been executed (see
  749.                                SSSShhhheeeellllllll VVVVaaaarrrriiiiaaaabbbblllleeeessss above).
  750.                        iiiinnnntttteeeerrrraaaaccccttttiiiivvvveeee----ccccoooommmmmmmmeeeennnnttttssss
  751.                                Allow a word beginning with #### to cause
  752.                                that word and all remaining characters
  753.                                on that line to be ignored in an
  754.                                interactive shell (see CCCCOOOOMMMMMMMMEEEENNNNTTTTSSSS above).
  755.                        mmmmoooonnnniiiittttoooorrrr Same as ----mmmm.
  756.                        nnnnoooocccclllloooobbbbbbbbeeeerrrr
  757.                                Same as ----CCCC.
  758.                        nnnnooooeeeexxxxeeeecccc  Same as ----nnnn.
  759.                        nnnnoooogggglllloooobbbb  Same as ----ffff.
  760.                        nnnnoooohhhhaaaasssshhhh  Same as ----dddd.
  761.                        nnnnoooottttiiiiffffyyyy  Same as ----bbbb.
  762.                        nnnnoooouuuunnnnsssseeeetttt Same as ----uuuu.
  763.                        pppphhhhyyyyssssiiiiccccaaaallll
  764.                                Same as ----PPPP.
  765.                        ppppoooossssiiiixxxx   Change the behavior of bash where the
  766.                                default operation differs from the
  767.                                Posix 1003.2 standard to match the
  768.                                standard.
  769.                        pppprrrriiiivvvviiiilllleeeeggggeeeedddd
  770.                                Same as ----pppp.
  771.                        vvvveeeerrrrbbbboooosssseeee Same as ----vvvv.
  772.                        vvvviiii      Use a vi-style command line editing
  773.                                interface.
  774.                        xxxxttttrrrraaaacccceeee  Same as ----xxxx.
  775.                        If no _o_p_t_i_o_n-_n_a_m_e is supplied, the values of
  776.                        the current options are printed.
  777.                ----pppp      Turn on _p_r_i_v_i_l_e_g_e_d mode.  In this mode, the
  778.                        $$$$EEEENNNNVVVV file is not processed, and shell functions
  779.                        are not inherited from the environment.  This
  780.                        is enabled automatically on startup if the
  781.                        effective user (group) id is not equal to the
  782.                        real user (group) id.  Turning this option off
  783.                        causes the effective user and group ids to be
  784.                        set to the real user and group ids.
  785.                ----tttt      Exit after reading and executing one command.
  786.  
  787.  
  788.  
  789.      Page 12                                          (printed 7/7/95)
  790.  
  791.  
  792.  
  793.  
  794.  
  795.  
  796.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  797.  
  798.  
  799.  
  800.                ----uuuu      Treat unset variables as an error when
  801.                        performing parameter expansion.  If expansion
  802.                        is attempted on an unset variable, the shell
  803.                        prints an error message, and, if not
  804.                        interactive, exits with a non-zero status.
  805.                ----vvvv      Print shell input lines as they are read.
  806.                ----xxxx      After expanding each _s_i_m_p_l_e-_c_o_m_m_a_n_d, bbbbaaaasssshhhh
  807.                        displays the expanded value of PPPPSSSS4444, followed by
  808.                        the command and its expanded arguments.
  809.                ----llll      Save and restore the binding of _n_a_m_e in a ffffoooorrrr
  810.                        _n_a_m_e [in wwwwoooorrrrdddd] command (see SSSSHHHHEEEELLLLLLLL GGGGRRRRAAAAMMMMMMMMAAAARRRR
  811.                        above).
  812.                ----dddd      Disable the hashing of commands that are looked
  813.                        up for execution.  Normally, commands are
  814.                        remembered in a hash table, and once found, do
  815.                        not have to be looked up again.
  816.                ----CCCC      The effect is as if the shell command
  817.                        `noclobber=' had been executed (see SSSShhhheeeellllllll
  818.                        VVVVaaaarrrriiiiaaaabbbblllleeeessss above).
  819.                ----HHHH      Enable !!!! style history substitution.  This flag
  820.                        is on by default when the shell is interactive.
  821.                ----PPPP      If set, do not follow symbolic links when
  822.                        performing commands such as ccccdddd which change the
  823.                        current directory.  The physical directory is
  824.                        used instead.
  825.                --------      If no arguments follow this flag, then the
  826.                        positional parameters are unset.  Otherwise,
  827.                        the positional parameters are set to the _a_r_gs,
  828.                        even if some of them begin with a ----.
  829.                ----       Signal the end of options, cause all remaining
  830.                        _a_r_gs to be assigned to the positional
  831.                        parameters.  The ----xxxx and ----vvvv options are turned
  832.                        off.  If there are no _a_r_gs, the positional
  833.                        parameters remain unchanged.
  834.  
  835.                The flags are off by default unless otherwise noted.
  836.                Using + rather than - causes these flags to be turned
  837.                off.  The flags can also be specified as options to an
  838.                invocation of the shell.  The current set of flags may
  839.                be found in $$$$----.  After the option arguments are
  840.                processed, the remaining _n _a_r_gs are treated as values
  841.                for the positional parameters and are assigned, in
  842.                order, to $$$$1111, $$$$2222, ............ $$$$_n.  If no options or _a_r_gs are
  843.                supplied, all shell variables are printed.  The return
  844.                status is always true unless an illegal option is
  845.                encountered.
  846.  
  847.           sssshhhhiiiifffftttt [_n]
  848.                The positional parameters from _n+1 ... are renamed to
  849.                $$$$1111 ................ Parameters represented by the numbers $$$$#### down
  850.                to $$$$####-_n+1 are unset.  If _n is 0, no parameters are
  851.                changed.  If _n is not given, it is assumed to be 1.  _n
  852.  
  853.  
  854.  
  855.      Page 13                                          (printed 7/7/95)
  856.  
  857.  
  858.  
  859.  
  860.  
  861.  
  862.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  863.  
  864.  
  865.  
  866.                must be a non-negative number less than or equal to $$$$####.
  867.                If _n is greater than $$$$####, the positional parameters are
  868.                not changed.  The return status is greater than 0 if _n
  869.                is greater than $$$$#### or less than 0; otherwise 0.
  870.  
  871.           ssssuuuussssppppeeeennnndddd [----ffff]
  872.                Suspend the execution of this shell until it receives a
  873.                SSSSIIIIGGGGCCCCOOOONNNNTTTT signal.  The ----ffff option says not to complain if
  874.                this is a login shell; just suspend anyway.  The return
  875.                status is 0 unless the shell is a login shell and ----ffff is
  876.                not supplied, or if job control is not enabled.
  877.  
  878.           tttteeeesssstttt _e_x_p_r
  879.           [[[[ _e_x_p_r ]]]]
  880.                Return a status of 0 (true) or 1 (false) depending on
  881.                the evaluation of the conditional expression _e_x_p_r.
  882.                Expressions may be unary or binary.  Unary expressions
  883.                are often used to examine the status of a file.  There
  884.                are string operators and numeric comparison operators
  885.                as well.  Each operator and operand must be a separate
  886.                argument.  If _f_i_l_e is of the form /dev/fd/_n, then file
  887.                descriptor _n is checked.
  888.                ----bbbb _f_i_l_e
  889.                     True if _f_i_l_e exists and is block special.
  890.                ----cccc _f_i_l_e
  891.                     True if _f_i_l_e exists and is character special.
  892.                ----dddd _f_i_l_e
  893.                     True if _f_i_l_e exists and is a directory.
  894.                ----eeee _f_i_l_e
  895.                     True if _f_i_l_e exists.
  896.                ----ffff _f_i_l_e
  897.                     True if _f_i_l_e exists and is a regular file.
  898.                ----gggg _f_i_l_e
  899.                     True if _f_i_l_e exists and is set-group-id.
  900.                ----kkkk _f_i_l_e
  901.                     True if _f_i_l_e has its ``sticky'' bit set.
  902.                ----LLLL _f_i_l_e
  903.                     True if _f_i_l_e exists and is a symbolic link.
  904.                ----pppp _f_i_l_e
  905.                     True if _f_i_l_e exists and is a named pipe.
  906.                ----rrrr _f_i_l_e
  907.                     True if _f_i_l_e exists and is readable.
  908.                ----ssss _f_i_l_e
  909.                     True if _f_i_l_e exists and has a size greater than
  910.                     zero.
  911.                ----SSSS _f_i_l_e
  912.                     True if _f_i_l_e exists and is a socket.
  913.                ----tttt _f_d
  914.                     True if _f_d is opened on a terminal.
  915.                ----uuuu _f_i_l_e
  916.                     True if _f_i_l_e exists and its set-user-id bit is
  917.                     set.
  918.  
  919.  
  920.  
  921.      Page 14                                          (printed 7/7/95)
  922.  
  923.  
  924.  
  925.  
  926.  
  927.  
  928.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  929.  
  930.  
  931.  
  932.                ----wwww _f_i_l_e
  933.                     True if _f_i_l_e exists and is writable.
  934.                ----xxxx _f_i_l_e
  935.                     True if _f_i_l_e exists and is executable.
  936.                ----OOOO _f_i_l_e
  937.                     True if _f_i_l_e exists and is owned by the effective
  938.                     user id.
  939.                ----GGGG _f_i_l_e
  940.                     True if _f_i_l_e exists and is owned by the effective
  941.                     group id.
  942.                _f_i_l_e_1 -nnnntttt _f_i_l_e_2
  943.                     True if _f_i_l_e_1 is newer (according to modification
  944.                     date) than _f_i_l_e_2.
  945.                _f_i_l_e_1 -ooootttt _f_i_l_e_2
  946.                     True if _f_i_l_e_1 is older than file2.
  947.                _f_i_l_e_1 ----eeeeffff _f_i_l_e
  948.                     True if _f_i_l_e_1 and _f_i_l_e_2 have the same device and
  949.                     inode numbers.
  950.                ----zzzz _s_t_r_i_n_g
  951.                     True if the length of _s_t_r_i_n_g is zero.
  952.                ----nnnn _s_t_r_i_n_g
  953.                _s_t_r_i_n_g
  954.                     True if the length of _s_t_r_i_n_g is non-zero.
  955.                _s_t_r_i_n_g_1 ==== _s_t_r_i_n_g_2
  956.                     True if the strings are equal.
  957.                _s_t_r_i_n_g_1 !!!!==== _s_t_r_i_n_g_2
  958.                     True if the strings are not equal.
  959.                !!!! _e_x_p_r
  960.                     True if _e_x_p_r is false.
  961.                _e_x_p_r_1 -aaaa _e_x_p_r_2
  962.                     True if both _e_x_p_r_1 AND _e_x_p_r_2 are true.
  963.                _e_x_p_r_1 -oooo _e_x_p_r_2
  964.                     True if either _e_x_p_r_1 OR _e_x_p_r_2 is true.
  965.                _a_r_g_1 OOOOPPPP _a_r_g_2
  966.                     OOOOPPPP is one of ----eeeeqqqq, ----nnnneeee, ----lllltttt, ----lllleeee, ----ggggtttt, or ----ggggeeee.
  967.                     These arithmetic binary operators return true if
  968.                     _a_r_g_1 is equal, not-equal, less-than, less-than-
  969.                     or-equal, greater-than, or greater-than-or-equal
  970.                     than _a_r_g_2, respectively.  _A_r_g_1 and _a_r_g_2 may be
  971.                     positive integers, negative integers, or the
  972.                     special expression ----llll _s_t_r_i_n_g, which evaluates to
  973.                     the length of _s_t_r_i_n_g.
  974.  
  975.           ttttiiiimmmmeeeessss
  976.                Print the accumulated user and system times for the
  977.                shell and for processes run from the shell.  The return
  978.                status is 0.
  979.  
  980.           ttttrrrraaaapppp [----llll] [_a_r_g] [_s_i_g_s_p_e_c]
  981.                The command _a_r_g is to be read and executed when the
  982.                shell receives signal(s) _s_i_g_s_p_e_c.  If _a_r_g is absent or
  983.                ----, all specified signals are reset to their original
  984.  
  985.  
  986.  
  987.      Page 15                                          (printed 7/7/95)
  988.  
  989.  
  990.  
  991.  
  992.  
  993.  
  994.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  995.  
  996.  
  997.  
  998.                values (the values they had upon entrance to the
  999.                shell).  If _a_r_g is the null string this signal is
  1000.                ignored by the shell and by the commands it invokes.
  1001.                _s_i_g_s_p_e_c is either a signal name defined in <_s_i_g_n_a_l._h>,
  1002.                or a signal number. If _s_i_g_s_p_e_c is EEEEXXXXIIIITTTT (0) the command
  1003.                _a_r_g is executed on exit from the shell.  With no
  1004.                arguments, ttttrrrraaaapppp prints the list of commands associated
  1005.                with each signal number.  The ----llll option causes the
  1006.                shell to print a list of signal names and their
  1007.                corresponding numbers.  An argument of -------- disables
  1008.                option checking for the rest of the arguments.  Signals
  1009.                ignored upon entry to the shell cannot be trapped or
  1010.                reset.  Trapped signals are reset to their original
  1011.                values in a child process when it is created.  The
  1012.                return status is false if either the trap name or
  1013.                number is invalid; otherwise ttttrrrraaaapppp returns true.
  1014.  
  1015.           ttttyyyyppppeeee [----aaaallllllll] [----ttttyyyyppppeeee | ----ppppaaaatttthhhh] _n_a_m_e [_n_a_m_e ...]
  1016.                With no options, indicate how each _n_a_m_e would be
  1017.                interpreted if used as a command name.  If the ----ttttyyyyppppeeee
  1018.                flag is used, ttttyyyyppppeeee prints a phrase which is one of
  1019.                _a_l_i_a_s, _k_e_y_w_o_r_d, _f_u_n_c_t_i_o_n, _b_u_i_l_t_i_n, or _f_i_l_e if _n_a_m_e is
  1020.                an alias, shell reserved word, function, builtin, or
  1021.                disk file, respectively. If the name is not found, then
  1022.                nothing is printed, and an exit status of false is
  1023.                returned.  If the ----ppppaaaatttthhhh flag is used, ttttyyyyppppeeee either
  1024.                returns the name of the disk file that would be
  1025.                executed if _n_a_m_e were specified as a command name, or
  1026.                nothing if ----ttttyyyyppppeeee would not return _f_i_l_e.  If a command
  1027.                is hashed, ----ppppaaaatttthhhh prints the hashed value, not
  1028.                necessarily the file that appears first in PPPPAAAATTTTHHHH.  If
  1029.                the ----aaaallllllll flag is used, ttttyyyyppppeeee prints all of the places
  1030.                that contain an executable named _n_a_m_e.  This includes
  1031.                aliases and functions, if and only if the ----ppppaaaatttthhhh flag is
  1032.                not also used.  The table of hashed commands is not
  1033.                consulted when using ----aaaallllllll.  ttttyyyyppppeeee accepts ----aaaa, ----tttt, and ----pppp
  1034.                in place of ----aaaallllllll, ----ttttyyyyppppeeee, and ----ppppaaaatttthhhh, respectively.  An
  1035.                argument of -------- disables option checking for the rest of
  1036.                the arguments.  ttttyyyyppppeeee returns true if any of the
  1037.                arguments are found, false if none are found.
  1038.  
  1039.           uuuulllliiiimmmmiiiitttt [----SSSSHHHHaaaaccccddddffffmmmmssssttttppppnnnnuuuuvvvv [_l_i_m_i_t]]
  1040.                UUUUlllliiiimmmmiiiitttt provides control over the resources available to
  1041.                the shell and to processes started by it, on systems
  1042.                that allow such control.  The value of _l_i_m_i_t can be a
  1043.                number in the unit specified for the resource, or the
  1044.                value uuuunnnnlllliiiimmmmiiiitttteeeedddd.  The HHHH and SSSS options specify that the
  1045.                hard or soft limit is set for the given resource.  A
  1046.                hard limit cannot be increased once it is set; a soft
  1047.                limit may be increased up to the value of the hard
  1048.                limit.  If neither HHHH nor SSSS is specified, the command
  1049.                applies to the soft limit.  If _l_i_m_i_t is omitted, the
  1050.  
  1051.  
  1052.  
  1053.      Page 16                                          (printed 7/7/95)
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  1061.  
  1062.  
  1063.  
  1064.                current value of the soft limit of the resource is
  1065.                printed, unless the HHHH option is given.  When more than
  1066.                one resource is specified, the limit name and unit is
  1067.                printed before the value.  Other options are
  1068.                interpreted as follows:
  1069.                ----aaaa   all current limits are reported
  1070.                ----cccc   the maximum size of core files created
  1071.                ----dddd   the maximum size of a process's data segment
  1072.                ----ffff   the maximum size of files created by the shell
  1073.                ----mmmm   the maximum resident set size
  1074.                ----ssss   the maximum stack size
  1075.                ----tttt   the maximum amount of cpu time in seconds
  1076.                ----pppp   the pipe size in 512-byte blocks (this may not be
  1077.                     set)
  1078.                ----nnnn   the maximum number of open file descriptors (most
  1079.                     systems do not allow this value to be set, only
  1080.                     displayed)
  1081.                ----uuuu   the maximum number of processes available to a
  1082.                     single user
  1083.                ----vvvv   The maximum amount of virtual memory available to
  1084.                     the shell
  1085.  
  1086.                An argument of -------- disables option checking for the rest
  1087.                of the arguments.  If _l_i_m_i_t is given, it is the new
  1088.                value of the specified resource (the ----aaaa option is
  1089.                display only).  If no option is given, then ----ffff is
  1090.                assumed.  Values are in 1024-byte increments, except
  1091.                for ----tttt, which is in seconds, ----pppp, which is in units of
  1092.                512-byte blocks, and ----nnnn and ----uuuu, which are unscaled
  1093.                values.  The return status is 0 unless an illegal
  1094.                option is encountered, a non-numeric argument other
  1095.                than uuuunnnnlllliiiimmmmiiiitttteeeedddd is supplied as _l_i_m_i_t, or an error occurs
  1096.                while setting a new limit.
  1097.  
  1098.           uuuummmmaaaasssskkkk [----SSSS] [_m_o_d_e]
  1099.                The user file-creation mask is set to _m_o_d_e.  If _m_o_d_e
  1100.                begins with a digit, it is interpreted as an octal
  1101.                number; otherwise it is interpreted as a symbolic mode
  1102.                mask similar to that accepted by _c_h_m_o_d(1).  If _m_o_d_e is
  1103.                omitted, or if the ----SSSS option is supplied, the current
  1104.                value of the mask is printed.  The ----SSSS option causes the
  1105.                mask to be printed in symbolic form; the default output
  1106.                is an octal number.  An argument of -------- disables option
  1107.                checking for the rest of the arguments.  The return
  1108.                status is 0 if the mode was successfully changed or if
  1109.                no _m_o_d_e argument was supplied, and false otherwise.
  1110.  
  1111.           uuuunnnnaaaalllliiiiaaaassss [-aaaa] [_n_a_m_e ...]
  1112.                Remove _n_a_m_es from the list of defined aliases.  If ----aaaa
  1113.                is supplied, all alias definitions are removed.  The
  1114.                return value is true unless a supplied _n_a_m_e is not a
  1115.                defined alias.
  1116.  
  1117.  
  1118.  
  1119.      Page 17                                          (printed 7/7/95)
  1120.  
  1121.  
  1122.  
  1123.  
  1124.  
  1125.  
  1126.      BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))     GGGGNNNNUUUU ((((1111999999993333 SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 11116666))))     BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111))))
  1127.  
  1128.  
  1129.  
  1130.           uuuunnnnsssseeeetttt [-ffffvvvv] [_n_a_m_e ...]
  1131.                For each _n_a_m_e, remove the corresponding variable or,
  1132.                given the ----ffff option, function.  An argument of --------
  1133.                disables option checking for the rest of the arguments.
  1134.                Note that PPPPAAAATTTTHHHH, IIIIFFFFSSSS, PPPPPPPPIIIIDDDD, PPPPSSSS1111, PPPPSSSS2222, UUUUIIIIDDDD, and EEEEUUUUIIIIDDDD
  1135.                cannot be unset.  If any of RRRRAAAANNNNDDDDOOOOMMMM, SSSSEEEECCCCOOOONNNNDDDDSSSS, LLLLIIIINNNNEEEENNNNOOOO, or
  1136.                HHHHIIIISSSSTTTTCCCCMMMMDDDD are unset, they lose their special properties,
  1137.                even if they are subsequently reset.  The exit status
  1138.                is true unless a _n_a_m_e does not exist or is non-
  1139.                unsettable.
  1140.  
  1141.           wwwwaaaaiiiitttt [_n]
  1142.                Wait for the specified process and return its
  1143.                termination status.  _n may be a process ID or a job
  1144.                specification; if a job spec is given, all processes in
  1145.                that job's pipeline are waited for.  If _n is not given,
  1146.                all currently active child processes are waited for,
  1147.                and the return status is zero.  If _n specifies a non-
  1148.                existant process or job, the return status is 127.
  1149.                Otherwise, the return status is the exit status of the
  1150.                last process or job waited for.
  1151.  
  1152.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  1153.           bash(1), sh(1)
  1154.  
  1155.  
  1156.  
  1157.  
  1158.  
  1159.  
  1160.  
  1161.  
  1162.  
  1163.  
  1164.  
  1165.  
  1166.  
  1167.  
  1168.  
  1169.  
  1170.  
  1171.  
  1172.  
  1173.  
  1174.  
  1175.  
  1176.  
  1177.  
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183.  
  1184.  
  1185.      Page 18                                          (printed 7/7/95)
  1186.  
  1187.  
  1188.  
  1189.